SureTax Returns API

POST Due Form Instances

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This API endpoint initiates the process of generating forms within the system. It serves as the trigger for creating various forms necessary for compliance or reporting purposes.

OperationId: POST Due Form Instances

Authorization Method(s): OAuth

Verb: POST

End Point: /api/v1/Forms/DueFormInstances

Request Body

OVERVIEWEXAMPLE

Request Model

Display Name	Field Name	Field Type
External Reporting Entity	externalReportingEntity	string
Forms	forms	array[DueForm]

DueForm

Display Name	Field Name	Field Type
Form Id	formId	string
Location Id	locationId	string
Reporting Period From Date	reportingPeriodFromDate	string
Reporting Period To Date	reportingPeriodToDate	string
Reporting Periodicity	reportingPeriodicity	string
Reporting Period Num	reportingPeriodNum	string
Reporting Phase	reportingPhase	string

Example Request

The following is an json request for this operation.

{
  "externalReportingEntity": "string",
  "forms": [
    {
      "formId": "string",
      "locationId": "string",
      "reportingPeriodFromDate": "string",
      "reportingPeriodToDate": "string",
      "reportingPeriodicity": "string",
      "reportingPeriodNum": "string",
      "reportingPhase": "string"
    }
  ]
}

Request Headers

Many of the request headers listed below are designed to enhance traceability and provide supplementary information, allowing our team to efficiently identify and assess your API requests. Including these headers offers numerous benefits: they improve debugging and support by facilitating quick issue identification, enhance security through secure access and traceable actions, ensure accurate request tracking for thorough auditing, support better client management for compatibility, enable localization and personalization for tailored responses, and optimize business processes with clearer operation definitions. For implementation examples, please refer to our SDKs, which provide comprehensive guidance and practical integrations.

Display String	Field Name	Field Type
X-request-id*	x-request-id	string

*Mandatory parameter

EmptyResponse

OVERVIEWEXAMPLE

Overview

An empty response object indicating that the request has been accepted but no content is returned.

EmptyResponse

Display Name	Field Name	Field Type

Example Response

The following is an example response you can expect for this operation

{}

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
202	Accepted. The request has been accepted for processing but is not completed yet.
400	Bad request. Invalid data provided.
401	Unauthorized access.
500	Internal server error.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/DueFormInstances

Add Request Headers:

{
  "externalReportingEntity": "string",
  "forms": [
    {
      "formId": "string",
      "locationId": "string",
      "reportingPeriodFromDate": "string",
      "reportingPeriodToDate": "string",
      "reportingPeriodicity": "string",
      "reportingPeriodNum": "string",
      "reportingPhase": "string"
    }
  ]
}